home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 6: Level 6 / 17 Bit - Level 6 (1998)(Epic Marketing)[!].iso / quartz / q0867.dms / q0867.adf / TRAPDOOR.LZH / Docs / TrapPoll.Man < prev   
Text File  |  1992-11-07  |  15KB  |  622 lines

  1.  
  2.  
  3.      Page 1              TrapDoor's Poll Scheduler              Page 1
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                  TrapPoll
  22.                          TrapDoor's Poll Scheduler
  23.                                Version 1.33
  24.                           Copyright (c) 1990-1992
  25.                    Maximilian Hantsch and Martin Laubach
  26.                             All rights reserved
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                              TrapPoll's Manual
  34.                         Thursday 05-Nov-92 10:22:30
  35.                           Copyright (c) 1990-1992
  36.                    Maximilian Hantsch and Martin Laubach
  37.                             All rights reserved
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.                   This manual is intended to be read from
  48.                     front to back for more convenience.
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.      Page 2              TrapDoor's Poll Scheduler              Page 2
  66.  
  67.  
  68.  
  69.   1. Introduction     
  70.  
  71.        This document is a brief description of TrapPoll, TrapDoor's
  72.      tiny Poll Scheduler, explaining how to set up the software in
  73.      order to have TrapDoor automatically poll all the systems that
  74.      have mail waiting.  
  75.  
  76.        Please read the entire manual before using TrapPoll.  
  77.  
  78.        TrapPoll scans your outbound directory, looking for .CLO, .CUT
  79.      and other similar files. It then decides what nodes have mail
  80.      waiting to be delivered and sends messages to a port named
  81.      "TrapDoor" (which happens to be TrapDoor's ARexx port), thus
  82.      telling TrapDoor to make calls to these nodes.  
  83.  
  84.        In a typical point setup, TrapPoll is not needed. In a node
  85.      environment, TrapPoll will be run every now and then to deliver
  86.      mail.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.   2. Basics     
  95.  
  96.        TrapPoll is a CLI based application, it can't be run from
  97.      WorkBench. It accepts a few configuration switches that allow an
  98.      easy and accurate configuration. All configuration switches must
  99.      be given on the commandline.  
  100.  
  101.        On invocation through a standard commandline interface or
  102.      shell, TrapPoll will parse the commandline, look for .?UT and
  103.      .?LO files in your outbound directory, check the proper flavour
  104.      for these files (Crash, Direct, Normal) and decide whether to
  105.      call these nodes. It will then send "CALL node-number" commands
  106.      to TrapDoor's ARexx port, causing TrapDoor to make outgoing
  107.      calls to these nodes. Also, TrapPoll will try to get the result
  108.      string of the call back from TrapDoor and display it. Just try
  109.      it, you will see immediately.  
  110.  
  111.        Please note that the configuration switches are neither case
  112.      sensitive nor do they have to appear in any specific order.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.      Basics
  125.  
  126.  
  127.      Page 3              TrapDoor's Poll Scheduler              Page 3
  128.  
  129.  
  130.  
  131.   3. Configuration Switches    
  132.  
  133.   3.1. General Configuration    
  134.  
  135.      -Z zone    
  136.  
  137.        This is the default zone that TrapPoll should use for
  138.      "old-style" .?LO and .?UT files, i.e. for files with 8-digit hex
  139.      net/nodenumber filenames.  
  140.  
  141.        Just specify your own zone number here. The default (if no -Z
  142.      switch is specified) is zone 2.  
  143.  
  144.      -O outbound-dir    
  145.  
  146.        This is the directory that TrapPoll will scan for outgoing
  147.      files. Set this to your normal outbound directory. The default
  148.      is "MAIL:Outbound/".  
  149.  
  150.      -P rexx-port-name    
  151.  
  152.        (new in version 1.23) 
  153.  
  154.        This is the ARexx portname to which TrapPoll will talk. The
  155.      default is "TrapDoor". If you are running TrapDoor on multiple
  156.      lines, different invocations of TrapDoor will have different
  157.      ARexx-portnames, and you can use this switch to direct TrapPoll
  158.      to call out on a specific line.  
  159.  
  160.   3.2. Mail Delivery Configuration   
  161.  
  162.        The following switches can be specified with both a leading
  163.      minus ("-") or plus ("+") sign, meaning "don't call" or "call"
  164.      respectively. The default is to call all nodes with "Crash"
  165.      (also called "Continuous") mail waiting.  
  166.  
  167.        Note that TrapPoll will never cause nodes with only "Hold"
  168.      mail to be called.  
  169.  
  170.      +C or -C   
  171.  
  172.        Tells TrapPoll to call (not call) nodes with "Crash" files
  173.      waiting for them. These files are named .CLO and/or .CUT.  
  174.  
  175.      +D or -D   
  176.  
  177.        Tells TrapPoll to call (not call) nodes with "Direct" files
  178.      waiting for them. These files are named .DLO and/or .DUT.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.      Configuration Switches                                 +D or -D
  187.  
  188.  
  189.      Page 4              TrapDoor's Poll Scheduler              Page 4
  190.  
  191.  
  192.      +N or -N   
  193.  
  194.        Tells TrapPoll to call (not call) nodes with "Normal" files
  195.      waiting for them. These files are named .FLO and/or .OUT.  
  196.  
  197.      +R or -R   
  198.  
  199.        (new in version 1.1) 
  200.  
  201.        Tells TrapPoll to call (not call) nodes with "Request" files
  202.      waiting for them. These files are named .REQ.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.      Configuration Switches                                 +R or -R
  249.  
  250.  
  251.      Page 5              TrapDoor's Poll Scheduler              Page 5
  252.  
  253.  
  254.  
  255.   4. Examples     
  256.  
  257.        To call all nodes that have "Crash" mail waiting for them, use 
  258.  
  259.           TrapPoll -z2 -omail:outbound +C -D -N -R -pTrapDoor 
  260.  
  261.        Incidentally, the above statement shows you all the default
  262.      settings of TrapPoll. Thus, you could also just type 
  263.  
  264.           TrapPoll 
  265.  
  266.        During the FidoNet zone mail hour (ZMH), you might want to
  267.      send mail only to "Direct" mail nodes (because some systems only
  268.      accept FidoNet mail sessions during that time), and not to
  269.      "Crash" nodes (so that your system is free for incoming calls as
  270.      much as possible). In this case, call 
  271.  
  272.           TrapPoll -C +D +N 
  273.  
  274.        By now, you certainly got the idea how all this works. If you
  275.      are still not sure, just go ahead and give it a try, you'll
  276.      immediately see how TrapPoll, TrapDoor and your outbound
  277.      directory interact.  
  278.  
  279.  
  280.  
  281.  
  282.   5. Return Values    
  283.  
  284.        TrapPoll will almost always return zero (0), except in special
  285.      cases when something has gone wrong. These special cases
  286.      include: incorrect outbound directory specification, disk error
  287.      during directory scan, the path specification for the outbound
  288.      directory is a file and not a directory etc.  
  289.  
  290.        On these errors, TrapPoll will return 20.  
  291.  
  292.        If there were no nodes to be called, TrapPoll returns 5.  
  293.  
  294.  
  295.  
  296.  
  297.   6. Future     
  298.  
  299.        TrapPoll is just a quick hack to give TrapDoor some scheduling
  300.      capabilities. There really needs to be more work done in that
  301.      field. It would be nice to have one smart "event scheduling"
  302.      program that combines the features of TeaTime, TrapPoll and
  303.      parts of the example "Main" script file. When we find some spare
  304.      time to work on that, we will code it.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.      Future
  311.  
  312.  
  313.      Page 6              TrapDoor's Poll Scheduler              Page 6
  314.  
  315.  
  316.  
  317.   7. Politics     
  318.  
  319.   7.1. Registration     
  320.  
  321.        TrapPoll is a copyrighted product that has been made available
  322.      to you as part of the TrapDoor project and thus, as Shareware.
  323.      All terms of the license agreement for TrapDoor also are true
  324.      for TrapPoll except as otherwise stated herein. Please consult
  325.      the documentation for TrapDoor for the complete license.  
  326.  
  327.        If you register TrapDoor, you automatically also gain a
  328.      license to use TrapPoll.  
  329.  
  330.        Should you decide that you wish to use TrapPoll on its own,
  331.      without registering TrapDoor, a ShareWare registration fee of
  332.      ATS 100,- is suggested. (Though we don't think that TrapPoll
  333.      alone without TrapDoor would be of much use.) By cooperating
  334.      with this concept you help to ensure continued development of
  335.      this product.  
  336.  
  337.        Site license information for commercial and government use can
  338.      be obtained directly from the authors.  
  339.  
  340.        No person(s) or businesses other than the authors are
  341.      authorized to accept any registration or distribution fees in
  342.      any form whatsoever. The only people who will be acknowledged as
  343.      registered users are those who have either registered TrapDoor
  344.      or sent ATS 100,- to: 
  345.  
  346.  
  347.  
  348.  
  349.  
  350.                            TrapDoor Development
  351.                             Maximilian Hantsch
  352.                       Matzleinsdorfer Platz 3-4/3/10
  353.                                 A-1050 Wien
  354.                              Austria / Europe
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.      Politics                                         Registration
  373.  
  374.  
  375.      Page 7              TrapDoor's Poll Scheduler              Page 7
  376.  
  377.  
  378.  
  379.   7.2. Distribution     
  380.  
  381.        TrapPoll may be redistributed with two restrictions. First, it
  382.      must be distributed as part of the TrapDoor package. Second, the
  383.      distributor may only charge a fee up to the costs of obtaining a
  384.      public domain diskette from Fred Fish for the complete package.  
  385.  
  386.        The distributor agrees to cease distributing the programs and
  387.      data involved if requested to do so by the author. The
  388.      distributor may only distribute an unmodified copy of the
  389.      original TrapDoor package, with all the supplied documentation
  390.      and copyright notices intact and without any files being added,
  391.      changed or omitted.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.   7.3. Support     
  403.  
  404.        If you have any suggestions, bug reports etc., feel free to
  405.      contact the authors of TrapPoll/TrapDoor at the above address.
  406.      Additionally, you can reach us at: 
  407.  
  408.           Maximilian Hantsch              Martin Laubach
  409.           Fido:   2:310/6                 Fido:   2:310/3.14
  410.           Uucp:   max@madvie.at           Uucp:   mjl@alison.at
  411.  
  412.        Also, there is a FidoNet Echomail conference called TRAPDOOR,
  413.      which should be available at major backbones. This conference is
  414.      in English and intended for the users of TrapDoor and, of
  415.      course, TrapPoll as well. There, you can freely exchange your
  416.      experience with these programs, discuss future enhancements you
  417.      would like to see etc. Both authors will participate in the
  418.      conference and try to assist you.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.      Politics                                              Support
  435.  
  436.  
  437.      Page 8              TrapDoor's Poll Scheduler              Page 8
  438.  
  439.  
  440.  
  441.   7.4. No Warranty    
  442.  
  443.        THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED
  444.      BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
  445.      COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS
  446.      IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
  447.      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  448.      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
  449.      RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH
  450.      YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
  451.      ALL NECESSARY SERVICING, REPAIR OR CORRECTION.  
  452.  
  453.        IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  454.      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
  455.      REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
  456.      FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
  457.      CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  458.      THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
  459.      BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
  460.      PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
  461.      PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED
  462.      OF THE POSSIBILITY OF SUCH DAMAGES.  
  463.  
  464.  
  465.  
  466.  
  467.   7.5. Disclaimer     
  468.  
  469.        No warranty, either express or implied, is made with respect
  470.      to the fitness or merchantability of TrapPoll.  
  471.  
  472.        Maximilian Hantsch and Martin Laubach (referred to as "the
  473.      authors"), reserve the right to not develop any future versions
  474.      of TrapPoll.  
  475.  
  476.        The authors will try to make a good faith attempt at
  477.      correcting any problems if any are discovered, but are in no way
  478.      required, nor bound to correct them.  
  479.  
  480.        The authors neither assume or accept any responsibility for
  481.      the use or misuse of this program. They also will not be held
  482.      liable for damages or any compensation beyond the original
  483.      registration fee due to loss of profit or any other damages
  484.      arising out of the use, or inability to use this program.  
  485.  
  486.        Neither Maximilian Hantsch nor Martin Laubach will be liable
  487.      for any damage arising from the failure of this program to
  488.      perform as described, or any destruction of other programs or
  489.      data residing on a system attempting to run the program. While
  490.      we know of no damaging errors, the user of this program uses it
  491.      at his or her own risk.  
  492.  
  493.  
  494.  
  495.  
  496.      Politics                                           Disclaimer
  497.  
  498.  
  499.      Page 9              TrapDoor's Poll Scheduler              Page 9
  500.  
  501.  
  502.  
  503.   8. Acknowledgements     
  504.  
  505.        The following names are either trademarks or the efforts of
  506.      the person and/or company listed: 
  507.  
  508.           Amiga and AmigaDOS are trademarks of Commodore-Amiga, Inc.
  509.           Fido and FidoNet are trademarks of Tom Jennings, Fido Software.
  510.           License Agreement inspired by Jack Radigan
  511.                          and the GNU General Public License.
  512.           Many Thanks to our Alpha and Beta testing crew, including,
  513.                          but not limited to:
  514.                          Manfred Schädler, Michael Röck,
  515.                          Michael Schmittner, Peter Wlcek,
  516.                          René Hexel, ...
  517.           No More Moral Support by Martina Patzelt.
  518.           Special Thanks to all our Registered TrapDoor Users.
  519.           TrapDoor by Maximilian Hantsch and Martin Laubach.
  520.           TrapPoll by Maximilian Hantsch and Martin Laubach.
  521.           TrapList by Martin Laubach and Maximilian Hantsch.
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.      Acknowledgements
  559.  
  560.  
  561.      Page I              TrapDoor's Poll Scheduler              Page I
  562.  
  563.  
  564.   Road Map
  565.  
  566.  
  567.         1. Introduction    .....................................    2
  568.         2. Basics    ...........................................    2
  569.         3. Configuration Switches   ............................    3
  570.            3.1. General Configuration   ........................    3
  571.            -Z zone   ...........................................    3
  572.            -O outbound-dir   ...................................    3
  573.            -P rexx-port-name   .................................    3
  574.            3.2. Mail Delivery Configuration  ...................    3
  575.            +C or -C  ...........................................    3
  576.            +D or -D  ...........................................    3
  577.            +N or -N  ...........................................    3
  578.            +R or -R  ...........................................    4
  579.         4. Examples    .........................................    5
  580.         5. Return Values   .....................................    5
  581.         6. Future    ...........................................    5
  582.         7. Politics    .........................................    6
  583.            7.1. Registration    ................................    6
  584.            7.2. Distribution    ................................    7
  585.            7.3. Support    .....................................    7
  586.            7.4. No Warranty   ..................................    8
  587.            7.5. Disclaimer    ..................................    8
  588.         8. Acknowledgements    .................................    9
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.      Road Map
  621.  
  622.